Skip to main content
Feedback

Working with custom libraries

These are the general steps for using custom libraries with your integration processes:

  1. Upload custom JAR files to an account by using the Manage Account Libraries page (Settings > Development Resources > Account Libraries).

    To upload files, you must have the Build Read and Write Access privilege and the Developer privilege. Typically, an administrator uploads the files for an account. Each account has access to 100 MB of space for uploaded files.

    note

    Uploaded or imported files pass through a virus scanner first. If the scan detects a virus, you receive an error message, and the scan rejects the file. If an error persists, contact Boomi Support.

  2. Create a Custom Library component and add one or more of the uploaded JAR files in the account library to the component.

    You can create three types of Custom Library components, depending on your integration needs: General, Scripting, and Connector. When you create a Connector custom library, you also specify a connector type, such as Database. Once you create a Custom Library component, you cannot change its type.

  3. Deploy the Custom Library component as you would any other deployable component.

    Because Custom Library components are not explicitly referenced by a process or any other component, you must deploy them independently. You can deploy these components to any Runtime, Runtime cluster, Runtime cloud, or environment.

    When you deploy one of these components, the JAR files that it references are deployed to the appropriate /userlib folder. For example:

    • For a Scripting type component, the JAR files are deployed to /userlib/script and those files become available for custom scripting steps or functions within a process.

    • For a Connector type component that is to be used with a Database connector, the JAR files are deployed to /userlib/database.

    • For a General type component containing JAR files that are required by more than one connector type, the JAR files are deployed to /userlib.

    note

    JAR files that are deployed to /userlib/script or /userlib/<connType> are available for use immediately. However, JAR files in a General type component that are deployed to /userlib are not available for use until after the next Runtime, Runtime cluster, or Execution worker restart (or, in the case of Runtime clouds, the next forked execution).